ACCESS

Section: System Calls (2)
Index Return to Main Contents

BSD mandoc
BSD 4

NAME

access - check access permissions of a file or pathname

SYNOPSIS

Fd #include <unistd.h> Ft int Fn access const char *path int mode

DESCRIPTION

The Fn access function checks the accessibility of the file named by Fa path for the access permissions indicated by Fa mode . The value of Fa mode is the bitwise inclusive OR of the access permissions to be checked ( R_OK for read permission, W_OK for write permission and X_OK for execute/search permission) or the existence test, F_OK All components of the pathname Fa path are checked for access permissions (including F_OK )

The real user ID is used in place of the effective user ID and the real group access list (including the real group ID) are used in place of the effective ID for verifying permission.

Even if a process has appropriate privileges and indicates success for X_OK the file may not actually have execute permission bits set. Likewise for R_OK and W_OK

RETURN VALUES

If Fa path cannot be found or if any of the desired access modes would not be granted, then a -1 value is returned; otherwise a 0 value is returned.

ERRORS

Access to the file is denied if:

Bq Er ENOTDIR: A component of the path prefix is not a directory.
Bq Er ENAMETOOLONG: A component of a pathname exceeded {NAME_MAX} characters, or an entire path name exceeded {PATH_MAX} characters.
Bq Er ENOENT: The named file does not exist.
Bq Er ELOOP: Too many symbolic links were encountered in translating the pathname.
Bq Er EROFS: Write access is requested for a file on a read-only file system.
Bq Er ETXTBSY: Write access is requested for a pure procedure (shared text) file presently being executed.
Bq Er EACCES: Permission bits of the file mode do not permit the requested access, or search permission is denied on a component of the path prefix. The owner of a file has permission checked with respect to the ``owner'' read, write, and execute mode bits, members of the file's group other than the owner have permission checked with respect to the ``group'' mode bits, and all others have permissions checked with respect to the ``other'' mode bits.
Bq Er EFAULT: Fa Path points outside the process's allocated address space.
Bq Er EIO: An I/O error occurred while reading from or writing to the file system.

STANDARDS

The Fn access function conforms to St -p1003.1-88 .

CAVEAT

Fn Access is a potential security hole and should never be used.

This document was created by man2html, using the manual pages.
Time: 19:41:55 GMT, December 25, 2022